Authenticating Users

Documentation for Unreal SDK API to manage sessions for the Sequence infrastructure stack for web3 gaming.

Requirements

• Make sure you have enabled your required login methods on Sequence Builder
• Visit our Platform Requirements page for detailed information on setting up and ensuring that the authentication methods you choose are properly configured in your Unreal project.

Start Email Login

Sign in users with any email, and they will receive a one-time password in their inbox. Listen for the Email Requires Code event.

Blueprint

Confirm Email Login with Code

Sign in users with any email, and they will receive a one-time password in their inbox. Listen for the Email Requires Code event.

Blueprint

Sign In as a Guest

You can sign in users as guests. However, note that they will lose access to their wallet if they uninstall the app or sign out. Leverage our account federation feature to link the wallet to another email or social account to keep access.

Blueprint

Social Sign In

To initiate SSO-based authentication on desktop, you need to navigate to a browser to obtain the necessary id_token. On mobile, our SDK handles this process for you using integrated plugins.

On desktop platforms, listen for the Sign in Web View Required event and open the returned Sign In URL. On mobile platforms, listen for the Id Token Received event.

When you call the Sign In functions, listen for the Session Established event on the SequenceSessionsBP subsystem to know when the sign in request was successful. Listen for Session Creation Failure when something went wrong.

Get Google Id Token

Blueprint

Get Apple Id Token

Blueprint

Sign In with Google

Sign In with a valid Google Id Token. You get this from the Get Google Id Token node.

Blueprint

Sign In with Apple

Sign In with a valid Apple Id Token. You get this from the Get Apple Id Token node.

Blueprint

Sign In with Epic

Sign In with a valid Epic Games Id Token. Checkout the EOS Plugin for Unreal

Blueprint

Start Session with OIDC Id Token

Use this method to start a session using a valid Id token from Google, Apple or Epic Games.

Blueprint

PlayFab

You will need to include your PlayFab Title ID in the SequenceConfig.ini file during Configuration and configure PlayFab in the Builder.

PlayFab Registration

Blueprint

PlayFab Login

Blueprint

PlayFab Authenticate with Session Ticket

Blueprint

Account Federation

To link another account to your wallet, simply re-use the same authentication methods. The SDK will check if there’s an existing session stored and will automatically attempt to link that account.